﻿<!DOCTYPE html>
<html>
<head>
    <title>Eventbrite Helper for WebMatrix - Reference</title>
    <link href="content/Site.css" rel="stylesheet" type="text/css" />
    <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
</head>
<body>
    <div class="container">
        <div class="header">
            <img src="content/images/webx-icon.png" alt="WebMatrix" />
            <img src="content/images/eventbrite-logo.png" alt="Plancast Logo" class="partnerLogo" />
            <h1>
                Microsoft WebMatrix Helpers</h1>
            <h2>
                Eventbrite Helper - Reference</h2>
        </div>
        <div class="content">
            <div class="navLinks">
                <a href="startHere.htm">Start Here</a> | <a href="reference.htm">Helper Reference</a>
            </div>
            <h3>
                Helper Methods</h3>
			<p><em>Note: Current version does not support the full Eventbrite API.</em></p>
            <table class="memberdecls">
                <tr>
                    <td class="memItemLeft">
                        static void
                    </td>
                    <td class="memItemRight">
                        <strong>Initialize</strong> (string appKey, [string userKey])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Initializes the Eventbrite helper with the Eventbrite application key and user key.
                        The user key is a string assigned by Eventbrite which identifies the user making
                        the method call. A valid user key is the recommended method for user authentication
                        with the Eventbrite API, instead of user/password.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static void
                    </td>
                    <td class="memItemRight">
                        <strong>Initialize</strong> (string appKey, string user, string password)
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Initializes the Eventbrite helper with the Eventbrite application key and your user
                        and password.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static IList&lt;<a href="#Event">Event</a>&gt;
                    </td>
                    <td class="memItemRight">
                        <strong>GetUserEventList</strong> ([string user], [string doNotDisplay], [string
                        eventStatuses], [string ascOrDesc])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method returns a list of user's events.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static <a href="http://developer.eventbrite.com/doc/tickets/ticket_new/">Process</a>
                    </td>
                    <td class="memItemRight">
                        <b>CreateNewTicket</b> (int eventId, string name, float price, int quantity, [bool
                        isDonation], [string description], [string startSales], [string endSales], [int
                        includeFee], [int min], [int max])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method creates new fixed-price or donation ticket types. It returns the ID
                        of the newly created ticket.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static <a href="http://developer.eventbrite.com/doc/events/event_new/">Process</a>
                    </td>
                    <td class="memItemRight">
                        <strong>CreateNewEvent</strong> (string title, string startDate, string endDate,
                        string timezone, int organizerId, int venueId, [string description], [int privacy],
                        [string personalizedUrl], [int capacity], [string currency], [string status], [string
                        customHeader], [string customFooter], [string backgroundColor], [string textColor],
                        [string linkColor], [string titleTextColor], [string boxBackgroundColor], [string
                        boxTextColor], [string boxBorderColor], [string boxHeaderBackgroundColor], [string
                        boxHeaderTextColor])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method creates a new event. It returns the ID of the newly created event.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static <a href="http://developer.eventbrite.com/doc/users/user_get/">User</a>
                    </td>
                    <td class="memItemRight">
                        <strong>GetUserInfo</strong> ([string userId], [string email])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method retrieves the data for a given user. If no userId or email provided,
                        returns the information of the current API user (owner of ApiKey).
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static <a href="#Event">Event</a>
                    </td>
                    <td class="memItemRight">
                        <strong>GetEvent</strong> (int eventId)
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Returns the data for a given event.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        @helper
                    </td>
                    <td class="memItemRight">
                        <strong>GetUserEventsWidget</strong> ([string user], [int count], [string title])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method renders a widget with a list of user's events.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        @helper
                    </td>
                    <td class="memItemRight">
                        <strong>GetTicketWidget</strong> (int eventId, [int height])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method shows a widget that allows to you sell tickets to an event from your
                        site.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        @helper
                    </td>
                    <td class="memItemRight">
                        <strong>GetCalendarWidget</strong> (int eventId, [int width], [int height])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        This method shows a widget that allows to you display a custom calendar widget for
                        your upcoming events.
                    </td>
                </tr>
            </table>
            <h4 id="Event">
                Event Information</h4>
            <table class="memberdecls">
                <tr>
                    <td width="163" class="memItemRight">
                        long <strong>Id</strong>
                    </td>
                    <td width="625" class="memItemRight">
                        The event ID.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Title</strong>
                    </td>
                    <td class="memItemRight">
                        The event title.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Description</strong>
                    </td>
                    <td class="memItemRight">
                        The event description.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Category</strong>
                    </td>
                    <td class="memItemRight">
                        The event category.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Tags</strong>
                    </td>
                    <td class="memItemRight">
                        The event tags/keywords.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>StartDate</strong>
                    </td>
                    <td class="memItemRight">
                        The event start date and time, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>EndDate</strong>
                    </td>
                    <td class="memItemRight">
                        The event end date and time, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Timezone</strong>
                    </td>
                    <td class="memItemRight">
                        The event timezone, as listed in the Olson timezones database (e.g. “America/New_York”).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Created</strong>
                    </td>
                    <td class="memItemRight">
                        The date and time the event was created, in ISO 8601 format (e.g., “2007-12-31 23:59:59″).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Modified</strong>
                    </td>
                    <td class="memItemRight">
                        The date and time the event was last modified, in ISO 8601 format (e.g., “2007-12-31
                        23:59:59″).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Privacy</strong>
                    </td>
                    <td class="memItemRight">
                        Private for a private event, Public for a public event.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Password</strong>
                    </td>
                    <td class="memItemRight">
                        Reserved for private event only.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>Capacity</strong>
                    </td>
                    <td class="memItemRight">
                        The total event capacity.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Url</strong>
                    </td>
                    <td class="memItemRight">
                        The event registration URL.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Logo</strong>
                    </td>
                    <td class="memItemRight">
                        The event logo URL.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Status</strong>
                    </td>
                    <td class="memItemRight">
                        The event status (“draft”, “live”, “started”, “ended”, or “canceled”).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        IList&lt;<a href="http://developer.eventbrite.com/doc/events/event_get/">Ticket</a>&gt; <strong>Tickets</strong>
                    </td>
                    <td class="memItemRight">
                        List of ticket types available for this event.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        Venue <strong>Venue</strong>
                    </td>
                    <td class="memItemRight">
                        The event venue.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>StartDateUtc</strong>
                    </td>
                    <td class="memItemRight">
                        The event start date and time in UTC.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>EndDateUtc</strong>
                    </td>
                    <td class="memItemRight">
                        The event end date and time to UTC timezone.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>StartDateLocal</strong>
                    </td>
                    <td class="memItemRight">
                        The event start date and time converted to the local timezone.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>EndDateLocal</strong>
                    </td>
                    <td class="memItemRight">
                        The event start date and time converted to the local timezone.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>VisibleTickets</strong>
                    </td>
                    <td class="memItemRight">
                        The different tickets types currently shown to public (leaving out hidden tickets).
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>TicketsSold</strong>
                    </td>
                    <td class="memItemRight">
                        The amount of tickets sold for the event.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>TicketsAvailable</strong>
                    </td>
                    <td class="memItemRight">
                        The amount of tickets available (still unsold) for the event.
                    </td>
                </tr>
            </table>
        </div>
        <ul class="footer">
            <li>We're always looking for <a href="mailto:webapp@microsoft.com">bugs, feedback and
                suggestions!</a></li>
            <li>&copy; 2010-2011 Microsoft Corporation. Powered by IIS Express.</li>
        </ul>
    </div>
</body>
</html>
